`General`: Warn users again before reloading certain pages with unsaved changes #10193

badkeyy · 2025-01-22T18:07:23Z

Checklist

General

I tested all changes and their related features with all corresponding user types on a test server.
Language: I followed the guidelines for inclusive, diversity-sensitive, and appreciative language.
I chose a title conforming to the naming conventions for pull requests.

Client

Important: I implemented the changes with a very good performance, prevented too many (unnecessary) REST calls and made sure the UI is responsive, even with large data (e.g. using paging).
I strictly followed the principle of data economy for all client-server REST calls.
I strictly followed the client coding and design guidelines.
Following the theming guidelines, I specified colors only in the theming variable files and checked that the changes look consistent in both the light and the dark theme.
I added multiple integration tests (Jest) related to the features (with a high test coverage), while following the test guidelines.
I added authorities to all new routes and checked the course groups for displaying navigation elements (links, buttons).
I documented the TypeScript code using JSDoc style.
I added multiple screenshots/screencasts of my UI changes.
I translated all newly inserted strings into English and German.

Motivation and Context

Fixes #10142

Exam Mode Testing

Prerequisites:

1 Instructor
1 Students
1 Exam with a Programming Exercise

Log in to Artemis
Participate in the exam as a student
Try to reload the page
Find that your browser warns you of unsaved changes before it reloads

Testserver States

Note

These badges show the state of the test servers.
Green = Currently available, Red = Currently locked
Click on the badges to get to the test servers.

Review Progress

Performance Review

I (as a reviewer) confirm that the client changes (in particular related to REST calls and UI responsiveness) are implemented with a very good performance even for very large courses with more than 2000 students.
I (as a reviewer) confirm that the server changes (in particular related to database calls) are implemented with a very good performance even for very large courses with more than 2000 students.

Code Review

Code Review 1
Code Review 2

Manual Tests

Test 1
Test 2

Exam Mode Test

Test 1
Test 2

Performance Tests

Test 1
Test 2

Test Coverage

Screenshots

Summary by CodeRabbit

New Features
- Added a browser warning mechanism to prevent accidental page exits during an exam, enhancing user experience and exam integrity.
- Introduced localized warning messages for unsaved changes in both English and German.
- Enhanced various components to display confirmation dialogs when there are unsaved changes, improving data protection across the application.

coderabbitai · 2025-01-22T18:12:43Z

Walkthrough

The pull request introduces new functionality across several components by adding @HostListener decorators that listen for the beforeunload event. This triggers methods to check for unsaved changes and display warning messages to users attempting to leave or reload the page. Additionally, new warning messages are added in both English and German language JSON files to inform users about potential data loss.

Changes

File	Change Summary
`src/main/webapp/app/exam/participate/exam-participation.component.ts`	- Added `HostListener` import from `@angular/core` - Implemented `beforeUnloadHandler` method for page unload warning
`src/main/webapp/i18n/de/exam.json`	- Added `reloadWarning` message in German for page reload alert
`src/main/webapp/i18n/en/exam.json`	- Added `reloadWarning` message in English for page reload alert
`src/main/webapp/app/admin/standardized-competencies/standardized-competency-management.component.ts`	- Added `unloadNotification` method for unsaved changes warning
`src/main/webapp/app/course/competencies/generate-competencies/generate-competencies.component.ts`	- Added `unloadNotification` method for unsaved changes warning
`src/main/webapp/app/course/competencies/import-standardized-competencies/course-import-standardized-course-competencies.component.ts`	- Added `unloadNotification` method for unsaved changes warning - Added `@HostListener` for `beforeunload` event
`src/main/webapp/app/course/competencies/import/import-course-competencies.component.ts`	- Added `unloadNotification` method for unsaved changes warning - Added `@HostListener` for `beforeunload` event
`src/main/webapp/app/exercises/modeling/participate/modeling-submission.component.ts`	- Added `unloadNotification` method for unsaved changes warning - Added `TranslateService` for translation of warning messages
`src/main/webapp/app/exercises/programming/shared/code-editor/container/code-editor-container.component.ts`	- Implemented `ComponentCanDeactivate` interface - Added `canDeactivate` and `unloadNotification` methods for unsaved changes warning
`src/main/webapp/app/exercises/quiz/manage/quiz-exercise-update.component.ts`	- Added `unloadNotification` method for unsaved changes warning
`src/main/webapp/app/exercises/text/participate/text-editor.component.ts`	- Added `unloadNotification` method for unsaved changes warning - Added `TranslateService` for translation of warning messages

Assessment against linked issues

Objective	Addressed	Explanation
Warn user before reload when in exam mode [#10142]	✅

Possibly related PRs

Development: Replace deprecated before unload event with pending changes guard #9479: The changes in the main PR, which introduce a beforeUnloadHandler method in the ExamParticipationComponent to handle the beforeunload event, are related to the modifications in the retrieved PR that also involve handling unsaved changes, albeit through a different mechanism using PendingChangesGuard. Both PRs focus on managing user interactions when navigating away from components with unsaved changes.

Suggested Labels

bugfix, tests, documentation, ready to merge

Suggested Reviewers

coolchock
SimonEntholzer
JohannesStoehr
pzdr7
BBesrour

✨ Finishing Touches

📝 Generate Docstrings (Beta)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 1

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between dd3bda4 and 60b172c.

📒 Files selected for processing (1)

src/main/webapp/app/exam/participate/exam-participation.component.ts (2 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

src/main/webapp/app/exam/participate/exam-participation.component.ts (1)

Pattern src/main/webapp/**/*.ts: angular_style:https://angular.io/guide/styleguide;methods_in_html:false;lazy_loading:true;code_reuse:true;tests:meaningful;types:PascalCase;enums:PascalCase;funcs:camelCase;props:camelCase;no_priv_prefix:true;strings:single_quotes;localize:true;btns:functionality;links:navigation;icons_text:newline;labels:associate;code_style:arrow_funcs,curly_braces,open_braces_same_line,indent_4;memory_leak_prevention:true;routes:naming_schema;chart_framework:ngx-charts;responsive_layout:true

⏰ Context from checks skipped due to timeout of 90000ms (5)

GitHub Check: Codacy Static Code Analysis
GitHub Check: client-tests
GitHub Check: server-tests
GitHub Check: Build and Push Docker Image
GitHub Check: Analyse

🔇 Additional comments (1)

src/main/webapp/app/exam/participate/exam-participation.component.ts (1)

1-1: LGTM!

The HostListener import is correctly added to the existing @angular/core imports.

src/main/webapp/app/exam/participate/exam-participation.component.ts

…tom message when reloading

zagemello

Tested on TS1, worked as expected:

Cathy0123456789

Tested on TS4. Works as described, warning is issued

vinceclifford

Tested on TS4, works as expected

github-actions · 2025-02-06T12:05:40Z

There hasn't been any activity on this pull request recently. Therefore, this pull request has been automatically marked as stale and will be closed if no further activity occurs within seven days. Thank you for your contributions.

src/main/webapp/app/exam/participate/exam-participation.component.ts

krusche

I would prefer @HostListener('window:beforeunload', ['$event']) because window:beforeunload is deprecated, also see my inline comment

…eload

apparently there is no alternative solution, so we will keep using the deprecated version

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

src/main/webapp/app/exercises/programming/shared/code-editor/container/code-editor-container.component.ts (1)
308-310: Consider enhancing the deactivation check.

The canDeactivate() method could be more robust by also checking the isLoading state to prevent navigation during file operations.
-    canDeactivate() {
-        return _isEmpty(this.unsavedFiles);
-    }
+    canDeactivate() {
+        return !this.isLoading && _isEmpty(this.unsavedFiles);
+    }

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ce29501 and c1bc701.

📒 Files selected for processing (9)

src/main/webapp/app/admin/standardized-competencies/standardized-competency-management.component.ts (2 hunks)
src/main/webapp/app/course/competencies/generate-competencies/generate-competencies.component.ts (2 hunks)
src/main/webapp/app/course/competencies/import-standardized-competencies/course-import-standardized-course-competencies.component.ts (2 hunks)
src/main/webapp/app/course/competencies/import/import-course-competencies.component.ts (2 hunks)
src/main/webapp/app/exam/participate/exam-participation.component.ts (2 hunks)
src/main/webapp/app/exercises/modeling/participate/modeling-submission.component.ts (4 hunks)
src/main/webapp/app/exercises/programming/shared/code-editor/container/code-editor-container.component.ts (4 hunks)
src/main/webapp/app/exercises/quiz/manage/quiz-exercise-update.component.ts (2 hunks)
src/main/webapp/app/exercises/text/participate/text-editor.component.ts (4 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

src/main/webapp/app/exam/participate/exam-participation.component.ts

🧰 Additional context used

📓 Path-based instructions (1)

`src/main/webapp/**/*.ts`: angular_style:https://angular.io/...

src/main/webapp/**/*.ts: angular_style:https://angular.io/guide/styleguide;methods_in_html:false;lazy_loading:true;code_reuse:true;tests:meaningful;types:PascalCase;enums:PascalCase;funcs:camelCase;props:camelCase;no_priv_prefix:true;strings:single_quotes;localize:true;btns:functionality;links:navigation;icons_text:newline;labels:associate;code_style:arrow_funcs,curly_braces,open_braces_same_line,indent_4;memory_leak_prevention:true;routes:naming_schema;chart_framework:ngx-charts;responsive_layout:true

src/main/webapp/app/course/competencies/generate-competencies/generate-competencies.component.ts
src/main/webapp/app/course/competencies/import/import-course-competencies.component.ts
src/main/webapp/app/admin/standardized-competencies/standardized-competency-management.component.ts
src/main/webapp/app/exercises/quiz/manage/quiz-exercise-update.component.ts
src/main/webapp/app/exercises/modeling/participate/modeling-submission.component.ts
src/main/webapp/app/course/competencies/import-standardized-competencies/course-import-standardized-course-competencies.component.ts
src/main/webapp/app/exercises/text/participate/text-editor.component.ts
src/main/webapp/app/exercises/programming/shared/code-editor/container/code-editor-container.component.ts

⏰ Context from checks skipped due to timeout of 90000ms (9)

GitHub Check: Codacy Static Code Analysis
GitHub Check: validate-pr-title
GitHub Check: Call Build Workflow / Build .war artifact
GitHub Check: Call Build Workflow / Build and Push Docker Image
GitHub Check: server-style
GitHub Check: client-tests-selected
GitHub Check: client-tests
GitHub Check: server-tests
GitHub Check: Analyse

🔇 Additional comments (8)

src/main/webapp/app/course/competencies/import/import-course-competencies.component.ts (1)

210-222: LGTM! Clean implementation of page reload warning.

The implementation correctly handles the beforeunload event and follows best practices:

Proper event prevention when there are unsaved changes

Reuse of existing canDeactivate() method

Localized warning message

src/main/webapp/app/course/competencies/import-standardized-competencies/course-import-standardized-course-competencies.component.ts (1)

182-194: LGTM! Consistent implementation of reload warning.

The implementation follows the established pattern and best practices:

Proper event handling

Reuse of canDeactivate() method

Consistent warning message

src/main/webapp/app/course/competencies/generate-competencies/generate-competencies.component.ts (1)

250-262: LGTM! Well-implemented reload warning.

The implementation maintains consistency with other components:

Proper event handling

Reuse of canDeactivate() method

Consistent warning message

src/main/webapp/app/exercises/programming/shared/code-editor/container/code-editor-container.component.ts (1)

317-324: LGTM! Well-implemented reload warning.

The implementation follows the established pattern and best practices:

Proper event handling

Reuse of canDeactivate() method

Consistent warning message

src/main/webapp/app/exercises/text/participate/text-editor.component.ts (1)

381-393: LGTM! Well-implemented unload notification.

The implementation follows Angular best practices and correctly handles the beforeunload event to prevent accidental data loss.

src/main/webapp/app/exercises/quiz/manage/quiz-exercise-update.component.ts (1)

378-390: LGTM! Consistent implementation of unload notification.

The implementation matches the pattern used in other components and correctly handles unsaved changes.

src/main/webapp/app/admin/standardized-competencies/standardized-competency-management.component.ts (1)

599-611: LGTM! Good use of getter for warning message.

The implementation follows the same pattern as other components while nicely encapsulating the warning message in a getter.

src/main/webapp/app/exercises/modeling/participate/modeling-submission.component.ts (1)

834-846: LGTM! Consistent implementation of unload notification.

The implementation follows the established pattern and correctly handles unsaved changes in the modeling submission.

krusche

Apparently, window:beforeunload is the only working option at the moment. Even though it is discouraged to use it, there is no viable solution to prevent accidental page reloads with unsaved changes. Therefore, I added it back to all places, that previously removed it (see #9479)

coolchock

code LGTM

coolchock

I also tested:
Locally - competencies
On TS5 - exam participation, modeling participation, code editor, quiz update, text editor
Everything works as expected and a warning is displayed both for navigation and reload

Add warning before page reload

60b172c

badkeyy requested a review from a team as a code owner January 22, 2025 18:07

github-actions bot assigned badkeyy Jan 22, 2025

github-actions bot added the client Pull requests that update TypeScript code. (Added Automatically!) label Jan 22, 2025

coderabbitai bot requested changes Jan 22, 2025

View reviewed changes

src/main/webapp/app/exam/participate/exam-participation.component.ts Outdated Show resolved Hide resolved

b-fein mentioned this pull request Jan 22, 2025

Assessment: Show confirmation dialogue when accidentally leaving assessment page #10028

Open

Made warning case more fine grain (coderabbit suggestion) and add cus…

9f9c080

…tom message when reloading

zagemello added the deploy:artemis-test3 label Jan 24, 2025

zagemello had a problem deploying to artemis-test3.artemis.cit.tum.de January 24, 2025 08:29 — with GitHub Actions Failure

github-actions bot added deployment-error Added by deployment workflows if an error occured and removed deploy:artemis-test3 labels Jan 24, 2025

zagemello added deploy:artemis-test1 and removed deployment-error Added by deployment workflows if an error occured labels Jan 24, 2025

zagemello temporarily deployed to artemis-test1.artemis.cit.tum.de January 24, 2025 08:34 — with GitHub Actions Inactive

github-actions bot added lock:artemis-test1 and removed deploy:artemis-test1 labels Jan 24, 2025

zagemello removed the lock:artemis-test1 label Jan 24, 2025

zagemello previously approved these changes Jan 24, 2025

View reviewed changes

ItsaaaMeMario added the deploy:artemis-test3 label Jan 28, 2025

ItsaaaMeMario had a problem deploying to artemis-test3.artemis.cit.tum.de January 28, 2025 19:17 — with GitHub Actions Failure

github-actions bot added deployment-error Added by deployment workflows if an error occured and removed deploy:artemis-test3 labels Jan 28, 2025

ItsaaaMeMario added deploy:artemis-test4 and removed deployment-error Added by deployment workflows if an error occured labels Jan 28, 2025

ItsaaaMeMario temporarily deployed to artemis-test4.artemis.cit.tum.de January 28, 2025 19:22 — with GitHub Actions Inactive

github-actions bot added lock:artemis-test4 and removed deploy:artemis-test4 labels Jan 28, 2025

ItsaaaMeMario removed the lock:artemis-test4 label Jan 28, 2025

Cathy0123456789 added the deploy:artemis-test4 label Jan 28, 2025

github-actions bot added lock:artemis-test4 and removed deploy:artemis-test4 labels Jan 28, 2025

Cathy0123456789 previously approved these changes Jan 28, 2025

View reviewed changes

Cathy0123456789 removed the lock:artemis-test4 label Jan 28, 2025

vinceclifford added the deploy:artemis-test4 label Jan 29, 2025

vinceclifford temporarily deployed to artemis-test4.artemis.cit.tum.de January 29, 2025 13:34 — with GitHub Actions Inactive

github-actions bot added lock:artemis-test4 and removed deploy:artemis-test4 labels Jan 29, 2025

vinceclifford previously approved these changes Jan 29, 2025

View reviewed changes

vinceclifford removed the lock:artemis-test4 label Jan 29, 2025

github-actions bot added the stale label Feb 6, 2025

krusche added this to the 7.10.0 milestone Feb 7, 2025

github-actions bot removed the stale label Feb 8, 2025

krusche reviewed Feb 9, 2025

View reviewed changes

src/main/webapp/app/exam/participate/exam-participation.component.ts Show resolved Hide resolved

krusche requested changes Feb 9, 2025

View reviewed changes

krusche added 2 commits February 9, 2025 14:25

Merge branch 'develop' into feature/exam-mode/warn-user-before-page-r…

ce29501

…eload

re-add @HostListener('window:beforeunload', ['$event']) in all places

c1bc701

apparently there is no alternative solution, so we will keep using the deprecated version

krusche dismissed stale reviews from Cathy0123456789, vinceclifford, and zagemello via c1bc701 February 9, 2025 13:49

krusche changed the title ~~Exam mode: Warn user before reloading the page~~ General: Warn users again before reloading certain pages with unsaved changes Feb 9, 2025

coderabbitai bot reviewed Feb 9, 2025

View reviewed changes

krusche approved these changes Feb 9, 2025

View reviewed changes

coderabbitai bot approved these changes Feb 9, 2025

View reviewed changes

coolchock approved these changes Feb 9, 2025

View reviewed changes

helios-aet bot temporarily deployed to artemis-test5.artemis.cit.tum.de February 9, 2025 15:27 Inactive

coolchock approved these changes Feb 9, 2025

View reviewed changes

krusche merged commit 050baf8 into develop Feb 9, 2025
29 of 39 checks passed

krusche deleted the feature/exam-mode/warn-user-before-page-reload branch February 9, 2025 16:32

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

`General`: Warn users again before reloading certain pages with unsaved changes #10193

`General`: Warn users again before reloading certain pages with unsaved changes #10193

badkeyy commented Jan 22, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jan 22, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

coderabbitai bot left a comment

zagemello left a comment

Cathy0123456789 left a comment •

edited

Loading

vinceclifford left a comment

github-actions bot commented Feb 6, 2025

krusche left a comment

coderabbitai bot left a comment

krusche left a comment

coolchock left a comment

coolchock left a comment

General: Warn users again before reloading certain pages with unsaved changes #10193

General: Warn users again before reloading certain pages with unsaved changes #10193

Conversation

badkeyy commented Jan 22, 2025 • edited by coderabbitai bot Loading

Checklist

General

Client

Motivation and Context

Exam Mode Testing

Testserver States

Review Progress

Performance Review

Code Review

Manual Tests

Exam Mode Test

Performance Tests

Test Coverage

Screenshots

Summary by CodeRabbit

coderabbitai bot commented Jan 22, 2025 • edited Loading

Walkthrough

Changes

Assessment against linked issues

Possibly related PRs

Suggested Labels

Suggested Reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

zagemello left a comment

Choose a reason for hiding this comment

Cathy0123456789 left a comment • edited Loading

Choose a reason for hiding this comment

vinceclifford left a comment

Choose a reason for hiding this comment

github-actions bot commented Feb 6, 2025

krusche left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

krusche left a comment

Choose a reason for hiding this comment

coolchock left a comment

Choose a reason for hiding this comment

coolchock left a comment

Choose a reason for hiding this comment

`General`: Warn users again before reloading certain pages with unsaved changes #10193

`General`: Warn users again before reloading certain pages with unsaved changes #10193

badkeyy commented Jan 22, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jan 22, 2025 •

edited

Loading

Cathy0123456789 left a comment •

edited

Loading